home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / libs / f1gplib352.lha / f1gplib_35.2 / README < prev    next >
Text File  |  1997-02-08  |  3KB  |  76 lines
  1. f1gp.library 35.2 (8.2.97)
  2. Copyright © 1995-1997 Oliver Roberts, All Rights Reserved.
  3. This library and the developer files are freely distributable.
  4.  
  5.   If you use f1gp.library in your program, please give me credit by
  6.   mentioning in the documentation that I wrote the library and retain
  7.   the copyright.  Thank you.
  8.  
  9.  
  10. DISTRIBUTION CONTENTS
  11.  
  12.   README        - this file
  13.   test          - example program
  14.   test.c        - C source for example program
  15.   History.txt   - revision history
  16.   libs/         - the library itself
  17.   doc/          - autodoc
  18.   include/    - C and assembler include files
  19.   fd/        - .FD file
  20.  
  21.  
  22. DESCRIPTION
  23.  
  24.   This library is currently used by add-on programs for MicroProse's F1GP
  25.   game including F1GP-Ed, SplitTime, AGPPerf and AGPLapTime.
  26.  
  27.   f1gp.library is a small library which provides 4 interface functions which
  28.   allows detection of F1GP and any program to be notified when F1GP quits.
  29.   There is also a function which can calulate the correct file checksum.
  30.  
  31.   The functions can be used after a Exec OpenLibrary(), and before your
  32.   program quits you MUST close the library.  F1GPBase must also be declared,
  33.   and the library base also has a few fields that can be read by your
  34.   program (see include/libraries/f1gp.h).
  35.  
  36.   EXAMPLE (see test.c for longer example)
  37.  
  38.      struct F1GPBase *F1GPBase;
  39.      if (F1GPBase = (struct F1GPBase *)OpenLibrary("f1gp.library",35))
  40.         CloseLibrary((struct Library *)F1GPBase);
  41.  
  42.  
  43.   In addition to detecting F1GP the f1gpDetect() function will patch the
  44.   following in F1GP (offsets refer to standard version):
  45.  
  46.     Offset     Bytes replaced        Description
  47.     ------     --------------        ------------
  48.     $8dc        4                    JSR before quit
  49.     $9cc        4                    JSR before quit
  50.     $a7e        4                    JSR before quit
  51.     $26dd1      11 (permanent)       Lap time calulation fix (Grant's)
  52.     $76d1e      4  (permanent)       JSR _LVOScreenToFront(A6) => NOPs
  53.     $76d82      4  (permanent)       JSR _LVOScreenToFront(A6) => NOPs
  54.  
  55.   Replacements marked with "permanent" are not restored when the library
  56.   is expunged.
  57.  
  58.   See f1gp.doc for descriptions of each function.  Include files for C and
  59.   Assembler are supplied, and need to be used.  The proto/f1gp.h file was
  60.   created for use with DICE C, and the pragmas/f1gp_pragmas.h file was
  61.   generated with DICE's fdtopragma, but should be compatible with other
  62.   C compilers.
  63.  
  64.  
  65. AUTHOR
  66.  
  67.   f1gp.library was programmed by F1GP-Ed author, Oliver Roberts.
  68.  
  69.    E-mail: Oliver@POBoxes.com
  70.       WWW: http://www.nanunanu.org/~oliver/
  71.  
  72.   Address: 30 Tillett Road
  73.            Norwich
  74.            NR3 4BJ
  75.            England
  76.